﻿//////////////////////////////////////////////////////////////////
//
// Interfaces\IDashboard.cs
//
// Copyright (c) 2012 Dan Pike.
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation files
// (the "Software"), to deal in the Software without restriction,
// including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software,
// and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows.Forms;

namespace Interfaces
{
   public interface IDashboard
   {
      string Name { get; set; }
      DockStyle Dock { get; set; }
      Control AsControl { get; }
      IPlanet Planet { get; set; }

      ////////////////////////////////////////////////////////////////////////
      /// <summary>
      /// Get/set the camera position. Typically the host GUI will use this
      /// method to initialize a new game, as otherwise the camera tends to be
      /// moved by the user via checks in the tick() method for keyboard/mouse
      /// input
      /// </summary>
      /// <param name="position"></param>
      /// <param name="orientation"></param>
      /// <param name="newHome"></param>
      void SetCamera(ILocation position, ILocation orientation, bool newHome);

      ////////////////////////////////////////////////////////////////////////
      /// <summary>
      /// Housekeeping
      /// </summary>
      void Tick();

      ////////////////////////////////////////////////////////////////////////
      /// <summary>
      /// Set to false when deactivated, to stop the window reacting to input
      /// </summary>
      bool IsActive { get; set; }

      ////////////////////////////////////////////////////////////////////////
      /// <summary>
      /// Swap to/from wireframe display
      /// </summary>
      bool Wireframe { get; set; }

      ////////////////////////////////////////////////////////////////////////
      /// <summary>
      /// Enable/disable the lighting
      /// </summary>
      bool Lighting { get; set; }
   }
}
